@aws-sdk/client-iam
Advanced tools
AWS SDK for JavaScript Iam Client for Node.js, Browser and React Native
The @aws-sdk/client-iam npm package is part of the AWS SDK for JavaScript v3. It provides a modular way to interact with AWS Identity and Access Management (IAM), allowing developers to manage users, groups, roles, and policies programmatically. This package is useful for automating IAM tasks, integrating IAM management into custom applications, and managing permissions within AWS environments.
User Management
This feature allows for the creation, modification, and deletion of IAM users. The provided code sample demonstrates how to create a new IAM user.
const { IAMClient, CreateUserCommand } = require('@aws-sdk/client-iam');
const client = new IAMClient({ region: 'us-west-2' });
const createUserParams = { UserName: 'NewUser' };
const createUserCommand = new CreateUserCommand(createUserParams);
client.send(createUserCommand).then(response => console.log(response)).catch(error => console.error(error));Role Management
This feature manages IAM roles, including their creation and the policies attached to them. The code sample shows how to create a new role with an assume role policy.
const { IAMClient, CreateRoleCommand } = require('@aws-sdk/client-iam');
const client = new IAMClient({ region: 'us-west-2' });
const createRoleParams = {
RoleName: 'NewRole',
AssumeRolePolicyDocument: JSON.stringify({
Version: '2012-10-17',
Statement: [{
Effect: 'Allow',
Principal: { 'Service': 'ec2.amazonaws.com' },
Action: 'sts:AssumeRole'
}]
})
};
const createRoleCommand = new CreateRoleCommand(createRoleParams);
client.send(createRoleCommand).then(response => console.log(response)).catch(error => console.error(error));Policy Management
This feature involves the creation, updating, and deletion of IAM policies. The code sample illustrates how to create a new policy that allows actions on specified resources.
const { IAMClient, CreatePolicyCommand } = require('@aws-sdk/client-iam');
const client = new IAMClient({ region: 'us-west-2' });
const createPolicyParams = {
PolicyName: 'NewPolicy',
PolicyDocument: JSON.stringify({
Version: '2012-10-17',
Statement: [{
Effect: 'Allow',
Action: 'logs:CreateLogGroup',
Resource: 'arn:aws:logs:us-west-2:123456789012:*'
}]
})
};
const createPolicyCommand = new CreatePolicyCommand(createPolicyParams);
client.send(createPolicyCommand).then(response => console.log(response)).catch(error => console.error(error));The aws-sdk package is the older version of the AWS SDK for JavaScript. It includes support for IAM and other AWS services in a single package, unlike @aws-sdk/client-iam which is modular. The aws-sdk is less modular but can be easier for simple applications that need multiple AWS services.
While not for AWS, google-auth-library is similar in functionality for Google Cloud. It provides authentication and authorization functionalities for Google Cloud services, similar to how @aws-sdk/client-iam manages IAM for AWS. The comparison highlights how both packages are essential for managing security in cloud environments, albeit for different providers.
AWS SDK for JavaScript IAM Client for Node.js, Browser and React Native.
Identity and Access Management
Identity and Access Management (IAM) is a web service for securely controlling access to Amazon Web Services services. With IAM, you can centrally manage users, security credentials such as access keys, and permissions that control which Amazon Web Services resources users and applications can access. For more information about IAM, see Identity and Access Management (IAM) and the Identity and Access Management User Guide.
To install this package, simply type add or install @aws-sdk/client-iam using your favorite package manager:
npm install @aws-sdk/client-iamyarn add @aws-sdk/client-iampnpm add @aws-sdk/client-iamThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the IAMClient and
the commands you need, for example ListGroupsCommand:
// ES5 example
const { IAMClient, ListGroupsCommand } = require("@aws-sdk/client-iam");
// ES6+ example
import { IAMClient, ListGroupsCommand } from "@aws-sdk/client-iam";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new IAMClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListGroupsCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-iam";
const client = new AWS.IAM({ region: "REGION" });
// async/await.
try {
const data = await client.listGroups(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listGroups(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listGroups(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-iam package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
FAQs
AWS SDK for JavaScript Iam Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-iam receives a total of 835,370 weekly downloads. As such, @aws-sdk/client-iam popularity was classified as popular.
We found that @aws-sdk/client-iam demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.